package com.chenu.gamscriptman.config;

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * @author flyan
 * date 2020-01-08
 * @function swagger插件配置，用于自动生成API文档
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 配置API功能
     */
    @Bean
    public Docket createChenuMsysApi(){
        /* 每个API接口都需要用户名密码验证才能通过，所以请求头需要用户信息，我们现在配置它们 */
        ParameterBuilder usernamePar = new ParameterBuilder();
        ParameterBuilder passwordPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        usernamePar.name("username")
                .description("账号")
                .modelRef(new ModelRef("string"))
                .parameterType("header");
        passwordPar.name("password")
                .description("密码")
                .modelRef(new ModelRef("string"))
                .parameterType("header");
        pars.add(usernamePar.build());
        pars.add(passwordPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(chenuApiInfo())
                .select()
                /* 选择有API的类所在包 */
                .apis(RequestHandlerSelectors.basePackage("com.chenu.gamscriptman.controller"))
                .build()
                /* 每个调用都需要请求头中包含用户名和密码 */
                .globalOperationParameters(pars);
    }

    /**
     * 构建api文档的详细信息
     * @return
     */
    private ApiInfo chenuApiInfo(){
        return new ApiInfoBuilder()
                //页面标题
                .title("辰湖游戏管理系统1.0 API文档")
                //创建人
                .contact(new Contact("Flyan@Chenu", "http://chenublogs.com", "flyan_by_chenu@sina.com"))
                //版本号
                .version("1.0")
                //描述
                .description("查询本API文档，快速上手游戏管理系统的接口使用")
                .build();
    }

}
